| Fully Qualified Name: | Laminas\Cache\Storage\Adapter\KeyListIterator |
| Implements: | IteratorInterface, Countable |
| Name | Description | Defined By |
|---|---|---|
| __construct() | Constructor | KeyListIterator |
| count() | Count number of items | KeyListIterator |
| current() | Get current key, value or metadata. | KeyListIterator |
| getMode() | Get iterator mode | KeyListIterator |
| getStorage() | Get storage instance | KeyListIterator |
| key() | Get current key | KeyListIterator |
| next() | Move forward to next element | KeyListIterator |
| rewind() | Rewind the Iterator to the first element. | KeyListIterator |
| setMode() | Set iterator mode | KeyListIterator |
| valid() | Checks if current position is valid | KeyListIterator |
Constructor
| Parameter Name | Type | Description |
|---|---|---|
| $storage | \StorageInterface | |
| $keys | array |
Returns:
Count number of items
Returns: int
Get current key, value or metadata.
Returns: mixed
Get iterator mode
Returns: int Value of IteratorInterface::CURRENT_AS_*
Get storage instance
Returns: \StorageInterface
Get current key
Returns: string
Move forward to next element
Returns: void
Rewind the Iterator to the first element.
Returns: void
Set iterator mode
| Parameter Name | Type | Description |
|---|---|---|
| $mode | int |
Returns: \KeyListIterator Provides a fluent interface
Checks if current position is valid
Returns: bool